Skip to content

docs: README privacy wording and navigation pass#1091

Merged
nadaverell merged 4 commits into
mainfrom
daria/readme-review-fixes
Jul 10, 2026
Merged

docs: README privacy wording and navigation pass#1091
nadaverell merged 4 commits into
mainfrom
daria/readme-review-fixes

Conversation

@dovzhikova

@dovzhikova dovzhikova commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

Refreshes the README so the first screen and security story match Radar’s current product positioning: a local-first Kubernetes UI that runs as a single binary, requires no account or agents, and keeps cluster data local.

What changed

  • Standardizes the hero around “The missing open-source Kubernetes UI” and a shorter trust line: single binary, no account required, free forever.
  • Adds a collapsible table of contents so the long README is easier to scan.
  • Reworks the first-screen feature line around topology, resources, GitOps, traffic, audit, and MCP context for AI agents.
  • Reworks the Why Radar section with concrete performance language, private-by-design / airgapped-friendly messaging, and a validated scale claim for tens of thousands of pods.
  • Clarifies installation and usage details: kubectl radar is universal; quick install, PowerShell, Homebrew, and Scoop also set up radar; Krew and direct downloads use kubectl radar unless users add a symlink.
  • Adds a README Security section and aligns SECURITY.md around the core trust promise: no cluster telemetry, no upload of manifests, logs, events, metrics, or resource data to Skyhook, and no account, agent, or cloud backend requirement.
  • Uses “AI agents” consistently across README, MCP docs, GitOps docs, and the MCP setup dialog.
  • Keeps roadmap detail out of the README by linking RBAC follow-ups to RBAC visibility: considered follow-ups #1090; removes the MCP beta label and adds Discussions/community pointers.

Testing

  • git diff --check origin/main...HEAD
  • Docs/copy-only change; no runtime tests or visual test run.

@nadaverell nadaverell force-pushed the daria/readme-review-fixes branch from ea2dade to a372fe5 Compare July 10, 2026 08:16
@nadaverell nadaverell changed the title docs: README accuracy + navigation pass (tagline, airgapped claim, TOC, security section) docs: README privacy wording and navigation pass Jul 10, 2026
@nadaverell nadaverell force-pushed the daria/readme-review-fixes branch from a372fe5 to 41c31be Compare July 10, 2026 08:17
dovzhikova and others added 3 commits July 10, 2026 12:20
Refresh the README hero, navigation, install notes, performance wording, privacy positioning, RBAC follow-up link, testimonial, and community links.
@nadaverell nadaverell force-pushed the daria/readme-review-fixes branch from 67346ee to efdf1a4 Compare July 10, 2026 09:22
@nadaverell nadaverell merged commit de9e29a into main Jul 10, 2026
9 checks passed
@nadaverell nadaverell deleted the daria/readme-review-fixes branch July 10, 2026 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants